File README.c

 RCS Header: /home/amb/cxref/RCS/README.c 1.2 1995/07/30 17:16:07 amb Exp

A comment for the file, RCS header comments are treated specially when first.

Included Files

A #include comment

  • #include <stdio.h>
    • An alternative #include comment.

  • #include <math.h>

    • Preprocessor definitions

    A #define comment.

    #define def1 1

    An alternative #define comment.

    #define def2 2

    A #define with args

    #define def3( arg1, arg2 )

    arg1
    The first arg
    arg2
    The second arg

    An alternative #define with args.

    #define def4( arg1, arg2 )

    arg1
    The first arg
    arg2
    The second arg

    Typedef type1

     An example typedef comment

    typedef enum {...} type1

    enum
    {
    one one value
    two another value
    }

    Type union bar

     Nested structs and unions also work.

    union bar
    {
    void a Each element
    int b of a struct
    int c or a union
    long d can have a comment
    }

    Typedef type2

     Another example typedef comment, a type that is a struct.

    typedef struct {...} type2

    struct
    {
    int a A variable in a struct.
    union bar Nested structs and unions also work.
    {
    void a Each element
    int b of a struct
    int c or a union
    long d can have a comment
    }
     e
    }

    Typedef ptype2

     Another example typedef comment, a pointer to a struct type.

    typedef struct {...}* ptype2

    See:
  • Typedef type2

    • Global Variable var1

     A leading comment only.

    int var1

    Global Variable var2

     A leading comment only.

    int var2

    Global Variable var3

     A trailing comment only.

    int var3

    Global Variable var4

     A variable for one thing.

    int var4

    Global Variable var5

     A variable for a second thing.

    int var5

    Global Variable var6

     A variable for a third thing.

    int var6

    Global Function function1()

     A function comment (the comments for the args need to be separated by a blank line).

    int function1 ( int arg1, int arg2 )

    int function1
    The return value.
    int arg1
    The first argument.
    int arg2
    The second argument.
    Some more comment
    An internal comment in a function that appears as a new paragraph at the end of the comment.

    Global Function function2()

     An alternative function comment

    int function2 ( int arg1, int arg2 )

    int function2
    Returns a value
    int arg1
    The first argument.
    int arg2
    The second argument.